\hypertarget{tool__function__forshow_8m}{
\subsection{tool\_\-function\_\-forshow.m File Reference}
\label{d1/df3/tool__function__forshow_8m}\index{tool\_\-function\_\-forshow.m@{tool\_\-function\_\-forshow.m}}
}


This is an example of a MATLAB function to show the main capabilities of the documentation using Doxygen, LaTeX, and an on-\/the-\/fly Perl script.  


\subsubsection*{Functions}
\begin{DoxyCompactItemize}
\item 
function \hyperlink{tool__function__forshow_8m_a1b57e8af79fd31f9313112818a6e8dac}{tool\_\-function\_\-forshow} (in grad\_\-row, in grad\_\-col)
\end{DoxyCompactItemize}


\subsubsection{Detailed Description}
This is an example of a MATLAB function to show the main capabilities of the documentation using Doxygen, LaTeX, and an on-\/the-\/fly Perl script. \begin{DoxyAuthor}{Author}
Mikhail V. Konnik 
\end{DoxyAuthor}
\begin{DoxyDate}{Date}
22 August 2011
\end{DoxyDate}
\hypertarget{d1/df3/tool__function__forshow_8m_functionforshow}{}\subsubsection{Documentation of a MATLAB funciton.}\label{d1/df3/tool__function__forshow_8m_functionforshow}
This test function shows how to document MATLAB functions in the described framework. The main points are:
\begin{DoxyItemize}
\item the names of input parameters (param) and return values (retval) must coincide with the names used in the function itself;
\item it is a good practice to write the expected type/size of variables;
\item the function(s) can contain brief descriptions as well. All the rest mark-\/up is valid for functions, scripts, and classes. 
\end{DoxyItemize}

Definition in file \hyperlink{tool__function__forshow_8m_source}{tool\_\-function\_\-forshow.m}.



\subsubsection{Function Documentation}
\hypertarget{tool__function__forshow_8m_a1b57e8af79fd31f9313112818a6e8dac}{
\index{tool\_\-function\_\-forshow.m@{tool\_\-function\_\-forshow.m}!tool\_\-function\_\-forshow@{tool\_\-function\_\-forshow}}
\index{tool\_\-function\_\-forshow@{tool\_\-function\_\-forshow}!tool_function_forshow.m@{tool\_\-function\_\-forshow.m}}
\paragraph[{tool\_\-function\_\-forshow}]{\setlength{\rightskip}{0pt plus 5cm}function tool\_\-function\_\-forshow (
\begin{DoxyParamCaption}
\item[{in}]{ grad\_\-row, }
\item[{in}]{ grad\_\-col}
\end{DoxyParamCaption}
)}\hfill}
\label{d1/df3/tool__function__forshow_8m_a1b57e8af79fd31f9313112818a6e8dac}


Test function to show the documentation of MATLAB functions. 


\begin{DoxyParams}{Parameters}
\item[{\em grad\_\-row}]= gradients matrix for ROWS \mbox{[}N-\/by-\/N\mbox{]} \item[{\em grad\_\-col}]= gradients matrix for COLUMNS \mbox{[}N-\/by-\/N\mbox{]}\end{DoxyParams}

\begin{DoxyRetVals}{Return values}
\item[{\em a}]= coefficients of reconstructed Zernike functions. \end{DoxyRetVals}
